Package com.orange.webcom.sdkv2.datasync

Exposes the API of the Webcom Realtime Database service (or "datasync" in short).

Types

Child

open class Child(addition: Boolean, removal: Boolean, change: Boolean) : Type

Represents the type of events raised when something happens to some child of a watched data node.

ChildEvent

Notification of a subscribed Child event type to a callback function (previously passed to one of the DatasyncNode.subscribe methods).

Constraint

sealed class Constraint

Represents constraints on the values of data nodes sent by subscriptions.

DataEvent

sealed class DataEvent

Represents a notification received through the Firebase Cloud Messaging service from the Webcom back end in response to a Subscription previously set up using one of the DatasyncNode.subscribeThroughNotifications methods.

DatasyncManager

class DatasyncManager

Handles a set of subscriptions to data nodes and authentication events.

DatasyncNode

class DatasyncNode : Subscriber

Represents a data node within the tree-like data of a Webcom application.

DatasyncService

class DatasyncService : WebcomAbstractService

The WebcomAbstractService that makes it possible to interact in real time with the data of a Webcom application.

DatasyncState

data class DatasyncState(isReachable: Boolean, connectionState: DatasyncState.ConnectionState, authenticationState: AuthenticationEvent.AuthenticationState)

Represents some state indicators about a DatasyncService instance.

DatasyncTime

enum DatasyncTime : Enum<DatasyncTime>

Represents a write policy into the Webcom database.

DatasyncValuable

class DatasyncValuable

Represents a tree-like value stored by the Webcom datasync service within its real-time database.

Event

sealed class Event

Represents a notification received by a callback function (previously passed to one of the DatasyncNode.subscribe methods) from the Webcom back end in response to a Subscription.

PresenceState

typealias PresenceState = ISO8601Date

Type used to publish the user's presence, which the DatasyncService.startPublishingMyPresence and DatasyncService.isPresent methods rely on.

This type should only be used to convert DatasyncValuable values using the DatasyncValuable.converted or DatasyncValuable.convertTo methods.

Subscriber

abstract class Subscriber

Base class for all subscription-related methods.

Subscription

interface Subscription

Represents a subscription to some event type on a data node.

SubscriptionCancelationPolicy

enum SubscriptionCancelationPolicy : Enum<SubscriptionCancelationPolicy>

Represents the policy to apply to the data stored within the local cache that are watched by a subscription when canceling this subscription.

TransactionOperation

sealed class TransactionOperation

Represents a write operation to perform on a data node within an atomic transaction.

TransactionResult

data class TransactionResult(value: DatasyncValuable, hasCompleted: Boolean)

Represents the result of a transaction run by the DatasyncNode.runTransaction method.

Type

sealed class Type

Represents the type of event to subscribe to.

ValueChanged

sealed class ValueChanged : Type

Represents the type of events raised when the value of a watched data node changes.

ValueChangedWithDataEvent

data class ValueChangedWithDataEvent : Event

Notification of a subscribed ValueChanged.WithData event type to a callback function (previously passed to one of the DatasyncNode.subscribe methods).

ValueChangedWithoutDataEvent

data class ValueChangedWithoutDataEvent : Event

Notification of a subscribed ValueChanged.WithoutData event type to a callback function (previously passed to one of the DatasyncNode.subscribe methods).